BCI NET 2/BCI NET 2.iso/archives/applications/misc/upsey.lha/UPSey/UPSey.guide

Amigaguide Document | 1994-07-14 | 13.4 KB | 305 lines

@database "UPSEY.guide"
@$VER: 1.01 (7/14/94)
@FONT topaz.font 8
@AUTHOR "Colin F. Thompson"
@WORDWRAP 70
@NODE MAIN "Table of Contents"
                   @{b}UPSey@{ub}@{fg highlight}        The UPS Zone Commodity
@{fg text}
               @{" Overview      " link OVER } What does it do?
               @{" Installation  " link INSTALL } Where does it live?
               @{" Databases     " link DBASE} Make one for yourself.
               @{" Customizing   " link CUSTOM} Tooltype Heaven
               @{" Using UPSey   " link USE} The good stuff
               @{" Registration  " link REG} How much does it cost?
               @{" Program Notes " link NOTES} C, GTX, Etc.
@{fg fill}

1994 by BOTH Software
@{fg text}
@ENDNODE
@NODE OVER
@{fg highlight}
            UPSey will translate ZIP Codes to UPS Zones.
@{fg text}
  UPSey is a commodity that is available to you from any program. Just
  press the Control Alt and the 'u' keys at the same time.
  UPSey requires WB 2.x and up. Hard drive installation is preferable.
  ReqTools Library must be present. It is not distributed with UPSey.
  UPSey requires a text file, called a 'database' to operate. One such
  database is provided. If you send parcels from an area other than
  San Diego, you will have to write an area-specific database. Complete
  instructions for writing the database are included in @{"Databases" link DBASE}.
@{fg highlight}
              UPSey is Giftware. Freely distributable.
@{fg text}
@ENDNODE
@NODE INSTALL
  UPSey can be installed by double clicking on the INSTALLUPSEY icon.
  This installation is automatic and you will not be asked any
  technical questions.
  You can manually install UPSey this way:
  Copy the executable (program) - UPSey and its icon to SYS:WBStartup
  Copy UPSey.doc, UPSey.guide, and "SanDiego.ups" to SYS:S
  The Installer does the same thing, automagically.
  If you want to store these files in another location, see @{"CUSTOM"LINK CUSTOM}.
@ENDNODE
@NODE DBASE
@LABEL "Writing your own Database""
  This is the first release of UPSey. Only one database,
  for the San Diego area is included. As new databases
  are written, we will include them in later releases.
@{fg highlight}
  ---------------Writing your Own Database --------------------
@{fg text}
  To make a new database, load up your favorite text editor.
  Get your copy of the UPS Zone Chart. Copy the information
  in the same order as you see below. You MUST make the first
  two lines in this manner:
             ;AREA:     <Your Sending Area>
             ;ZIP CODE: <Your Local Range>
  AREA:     is your Town.
  ZIP CODE: Copy this data from the top of the UPS Zone chart.
  The lines of archival information after ZIP CODE: are not needed.
  (Date, Author, Etc.) You may write anything here that you please.
  Neatness counts. The next person to look at your database may be
  using it as a template for their area.
  A poor typist will require 30 minutes to type the database.
  When you've finished, save the file as an ASCII file.
Here are the Rules:
   1. EACH LINE (RECORD) MUST BE 18 CHARACTERS LONG.
      NUMBERS AND SPACES ONLY.
   2. USE YOUR UPS ZONE CHART. IF A ZONE IS REPRESENTED BY
      A DASH OR ASTERICK, ENTER A ZERO OR 2 ZEROS IN ITS PLACE
   3. ENTER THE NUMBERS DIRECTLY FROM THE CHART.
      IF THERE IS ONLY A SINGLE PREFIX, ENTER THREE
      SPACES TO REPLACE THE ENDING PREFIX. EXAMPLE:
         327     7 37 12 22
         328 344 6 36 12 22
   4. ALASKA, CANADA AND INTERNATIONAL ZONES ARE NOT SUPPORTED.
      IN THIS VERSION.
@{fg highlight}
   UPS Domestic Zone Chart for the San Diego Area
@{fg text}
;AREA:          San Diego
;ZIP CODE:      919-01 921-99
;DATE:          6-9-94
;AUTHOR:        COLIN THOMPSON
;FOR USE WITH:  UPSEY
;FOR MORE INFO: UPSEY.GUIDE
;DEFAULT LOC:   SYS:S
;FILENAME:      SanDiego.ups
;REM CHAR:      SEMICOLON
;        ___________ Beginning Prefix
;       /  _________ Ending Prefix
;      /  /   ______ Ground Zone
;     /  /   / _____ 3 Day Select Zone
;    /  /   / /  ___ 2 Day Air Zone
;   /  /   / /  /  _ Next Day Air Zone
;  /  /   / /  /  /
; /  /   / /  /  /
;-- --- - -- -- --
004 005 8 38 12 22
006 007 0 00 15 25
008     0 00 00 00
009     0 00 15 25
010 089 8 38 12 22
090 099 0 00 00 00
100 199 8 38 12 22
------------------> Continued on the the bottom of the list.
@ENDNODE
@NODE CUSTOM
@TITLE "CHANGING THE TOOLTYPES"
ToolTypes:
@{fg highlight}
  ----------------- Where is the Database? --------------------
@{fg text}
  If you want to store the database someplace other than
  SYS:S, you will need to change the tooltype to let
  UPSey know where to look for your database.
  As an example, let's say you want put your database in a drawer
  called 'TEXTFILES', which is on a partition called WORK:
@{fg highlight}
Do it like this:@{fg text}
    From the Workbench, click once on the UPSey icon.
    Select INFORMATION from the pull down menus.
    Change the line that says DATABASE=SYS:S

        to read DATABASE=<PATH>
    EXAMPLE: DATABASE=WORK:TEXTFILES
    Press return and then SAVE.
  Remember, you can only have ONE database in the place UPSey is
  looking for databases. If more than one database is in that
  drawer, UPSEY may see the wrong one.
  By default, UPSey looks at the tooltype for the path to the
  database. If a path is not present, it looks in the drawer
  it is living in. That drawer would normally be WBStartup. If
  UPsey can't find a database there, it will look in s:. In the
  worst case, if UPSey can't find a database, a screen prompt
  will appear, telling you of a@{fg fill}
     'fatal error: can't find database'@{fg text}
@{fg highlight}
  -------------------- Qualifier Keys ---------------------------
@{fg text}
  The hot keys (Ctrl Alt u) may be changed. These values are
  kept in the icon as tooltypes. You may freely change them.
@{fg highlight}
  --------------- Where is UPSey's Window? ----------------------
@{fg text}
  You may find that UPSey appears on your screen in an inconvenient
  place. Through the use of Tooltypes, you can tell UPSey where to
  position itself whenever it is called.
  A "normal" Amiga has a screen resolution of 640 pixels wide and 200
  pixels tall. You should know the resolution of your own machine.
  Before you change the X-Y position tooltypes, run the program and
  see where it appears on your screen. If it is not in a good place,
  adjust the XPOSITION and/or the YPOSITION tooltype. Remember, these
  values refer to the upper left hand corner of UPSey's window in
  relationship to the screen's upper left hand corner.
  X is left-right, with the left edge of the screen being zero.
  Y is up-down, with the top of the screen being zero.
  You may adjust the values without harm to the program.
  XPOSITION=[number]
  YPOSITION=[number]
@{fg highlight}

  ----------------- Filename Conventions -------------------
@{fg text}
  Database filenames require an extension of '.ups'.
 @{fg highlight}
  ----------------------- Stack Size ------------------------
 @{fg text}
  The stack size is set to 16000 in the icon. Don't make it less,
  or you may get a free trip to India.
@ENDNODE
@NODE USE
@TITLE "Using the program"
 UPSey is a commodity. It lurks in the background, waiting for you to
 press the Control Alt and 'u' together. Then it appears on the
 frontmost public screen. (Usually the WorkBench).
 On the left side of the window is a 'listview' gadget that contains
 all of the legal ZIP Codes that UPS ships to from your area. Use
 the sliding bar or the arrows to select the ZIP code you want the
 Zone number for.
 This is exactly what you would do if you used the UPS Zone chart.
 Once you've found the range, click on it and all of the available
 Zone numbers will appear in boxes to the right. Click the close
 gadget to to make UPSey hide.
 The Zone numbers you see are valid only in the AREA listed. It is
 quite easy to make a list for your area. Complete instructions
 for this are available in the @{"Databases" LINK DBASE} section.
 The standard Project menu allows you to:
  HIDE -- Make UPSey disappear, but standing by to be called again.
          This is the same as clicking the close gadget.
  QUIT -- This shuts down UPSey. Memory is de-allocated and you must
          double click it's icon to activate UPSey again.
  ABOUT - A window appears and shouts the praises of BOTH Software.
 UPSey is a standard commodity and may be controlled by the Exchange.
@ENDNODE
@NODE REG
  UPSey is @{b}GIFTWARE@{ub}. That means if you like it and use
  it, you may send us a Gift. We like unpublished, homegrown
  utilities.  :]
  UPSey is free to use and copy as you see fit. The Authors retain all
  rights to the program. The Authors are not responsible for any
  damage the program may cause, i.e. wrong Zones, crashed systems,
  or thermonuclear war. The user assumes all responsibility.
  The United Parcel Service is in no way responsible for UPSey.
  UPSey was tested on a 2000, 600 (WB 2) and a 1200 (WB3.0)
  without problems.
@{fg highlight}
The Authors ask only two things from you:@{fg text}
   1. If you distribute the program, distribute the entire package.
      See below for a list of filenames to be included. You may
      not charge more than a nominal fee. Mr. Fred Fish is
      specifically allowed to distribute this package.
   2. If you write a Zone Chart database for your area, please send a
      copy so it may be included in subsequent releases. Give yourself
      credit in the text.
Files included in this release (1.00):
      UPSey -------- The executable
      SanDiego.ups-- The Zone Chart database
      UPSey.guide -- This AmigaGuide file
      UPSey.doc ---- Instructions for the Guideless
      InstallUPSey - The Autoinstall script
      UPSey.readme - A standard, vanilla readme
      <src> -------- Directory with the source code
If you find any bugs or have any comments, please contact the Authors:
@{fg highlight}
      C & UNIX Code                  Program Design, GUIs, Docs@{fg
text}
      --------------------------     --------------------------
      Will Bow                       Colin Thompson
      1531 Corinth Unit 1            9606 Carroll Cyn. Rd. H9
      West Los Angeles, CA 90025     San Diego, CA 92126
      [phone]                 [phone]
                                     InterNet: [e-mail]
@ENDNODE
@NODE NOTES
@{fg highlight}
---------------------- Programming Notes -----------------------
@{fg text}
@{fg highlight}
Future additions will include:
@{fg text}
 Adding Canadian and Alaskan Zones.
 Saving the window position when closed.
  If you have any suggestions, send them along. This program was
  written to complement Legendary Design Technologies' Addressit!.
  UPSey won't open on Addressit!'s private screen, but you can
  drag the screen down to reveal UPSey on the WorkBench screen.
@{fg highlight}
Thanks to:@{fg text} Jan van den Baard for GadToolsBox.
           Nico Francois for his ReqTools Library
           San Diego Amiga Users Group for beta testing.
           Fred Fish for his Fabulously Fishy Archives
@{fg highlight}
Additional programming Notes:
@{fg text}
  UPSey was written in Aztec C. The source files are included.
  If you come up with any improvements or modifications,
  please let the authors know.
  UPSey's method of dynamically allocating memory for the data
  should prove useful when modifying the program to display other
  forms of data. The data file can be of any length or have any
  number of fields. The GUI was done with GadToolsBox. We love it.
  The first time UPSey is called, the database is read into memory.
  It stays there until the computer is turned off, reset or the
  QUIT option on the menu is selected.
@{fg fill}
  In reference to reading in the first two strings - AREA and ZIP CODE
@{fg text}
  The user is instructed to make these strings the first ones in the
  list. This instruction was made purely to keep the database files
  neat looking. UPSey is a lot smarter than that.
  The two strings can be located anywhere within the file. If multiple
  occurrences are found, the last one takes precedence.
   That is:
       area: foo1
           .
           .
       area: foo2
   foo2 overides foo1
   The keywords "area:" and "zip code:" may appear anywhere in a comment
   line. Extraneous stuff may precede them i.e.:
 @{fg fill}
        ;garbage & junk area: <rest of line>
 @{fg text}
        is seen as "area: <rest of line>"
   Leading spaces before the first word in <rest of line> are skipped.
   Subsequent spaces embedded in <rest of line> are represented verbatim.
   <rest of line> will be displayed up to the newline '\n' and is NOT
   CHECKED FOR VALIDITY IN ANY WAY.  If it is longer than the
   display area, it is automatically truncated by intuition to fit.
Line lengths:
   Lines (records) do not necessarily have to be 18 chars long. It helps
   as far as human readability is concerned. What is important is that
   there are  5 or 6 fields per record, delimited by white space -
   (horiz tabs are also considered white space). Lines starting with ';'
   OR having less than 5, or more than 6 fields are SILENTLY ignored
   - with the exception of a comment line containing area: or zip code:.
File length:
  The database file may be as long as necessary. UPSey imposes no
  upper limits on file size
@ENDNODE